Skip to content

[Lock] Default path for FlockStore #13042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 5, 2020
Merged

Conversation

Guikingone
Copy link
Contributor

Hi everyone 👋

As noticed in the source code:

    /**
     * @param string|null $lockPath the directory to store the lock, defaults to the system's temporary directory
     *
     * @throws LockStorageException If the lock directory doesn’t exist or is not writable
     */
    public function __construct(string $lockPath = null)
    {
        if (null === $lockPath) {
            $lockPath = sys_get_temp_dir();
        }
        if (!is_dir($lockPath) || !is_writable($lockPath)) {
            throw new InvalidArgumentException(sprintf('The directory "%s" is not writable.', $lockPath));
        }

        $this->lockPath = $lockPath;
    }

sys_get_temp_dir is the default path is null is given in the constructor, could it be a good idea to notice this? 🤔

@OskarStark OskarStark added this to the 3.4 milestone Feb 4, 2020
@OskarStark
Copy link
Contributor

OskarStark commented Feb 5, 2020

Thank you @Guikingone I extended the code comment before, rather then keeping it as a note. To me it is an implementation detail which should be mentioned somewhere but not as prominent as a note. I also addressed @HeahDude's comment. All done in 3ea0737

OskarStark added a commit that referenced this pull request Feb 5, 2020
This PR was merged into the 3.4 branch.

Discussion
----------

[Lock] Default path for FlockStore

Hi everyone 👋

As noticed in the source code:

```php

    /**
     * @param string|null $lockPath the directory to store the lock, defaults to the system's temporary directory
     *
     * @throws LockStorageException If the lock directory doesn’t exist or is not writable
     */
    public function __construct(string $lockPath = null)
    {
        if (null === $lockPath) {
            $lockPath = sys_get_temp_dir();
        }
        if (!is_dir($lockPath) || !is_writable($lockPath)) {
            throw new InvalidArgumentException(sprintf('The directory "%s" is not writable.', $lockPath));
        }

        $this->lockPath = $lockPath;
    }
```

`sys_get_temp_dir` is the default path is null is given in the constructor, could it be a good idea to notice this? 🤔

Commits
-------

efbb0b3 refacto(Lock): FlockStore default path
@OskarStark OskarStark merged commit efbb0b3 into symfony:3.4 Feb 5, 2020
OskarStark added a commit that referenced this pull request Feb 5, 2020
OskarStark added a commit that referenced this pull request Feb 5, 2020
* 3.4:
  minor. refs #13042
  refacto(Lock): FlockStore default path
OskarStark added a commit that referenced this pull request Feb 5, 2020
* 4.4:
  minor. refs #13042
  refacto(Lock): FlockStore default path
OskarStark added a commit that referenced this pull request Feb 5, 2020
* 5.0:
  minor. refs #13042
  refacto(Lock): FlockStore default path
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants